![GitHubのリンク共有時のTips](https://devio2023-media.developers.io/wp-content/uploads/2019/07/github-eyecatch.png)
GitHubのリンク共有時のTips
どうも。 えーたん(@eetann092)です。
本記事では、ブログを書いたり実装を参考にするためのメモの時に便利な「GitHubのリンク共有時のTips」を紹介します。
リンク切れを防ぐ
たまに、ブログにあるGitHubのリンクをクリックしたら404になります。 原因の1つに、そのリンクがコミットと結び付いていない可能性があります。
以下がコミットと結び付いていない404になるリンクで、
最初のコミット
の時点ではfoo.txt
は存在します。
https://github.com/eetann/github-link-sample/blob/main/foo.txt
コミットと結び付いていないリンクは、最新のコミットであると判断さるため、 別のコミットによってファイルや行を移動・削除されると、目的のファイルや行に飛べなくなります。
これを解決するためにコミットと結び付けるには、ショートカットキーy
を入力します。
↓y
を押すことで、URLが変わります(画面上部)。
y
を入力すると、URLのブランチ名の部分がコミットIDに変わります。
以下のリンクはコミットと結び付いているため、404になりません。
https://github.com/eetann/github-link-sample/blob/ddaedd101035f9661461abaf57ef465866db10da/foo.txt
行を指定してリンクを共有する
あらかじめ見る行が分かっている場合、 ファイルではなく行を指定してリンクを共有すると便利です。
まず、1行だけを指定する場合は行番号をクリックするだけです。
以下のように、URLの最後に#L2
がつきます。
複数行を指定する場合は、さらにshift
を押しながらクリックします。
以下のように、URLの最後に#L2-L3
がつきます。
キーボードだけで操作したい場合、
l
入力後に出てくる画面で行番号を指定し、EnterするかGo
ボタンを押します。
たとえば、1〜3行目を指定したい場合は1-3
を入力します。
l
は単純に特定行へのジャンプとしても使えるため、行数が多いファイルを見る時にも便利です。
README.mdのようにレンダリングされるファイルで行数指定する場合は、 ファイル表示エリアの右上にあるアイコンをクリックし、レンダリングしない表示に切り替えることで可能です。
以下のように、URLにパラメータplain=1
がつきます。
Chrome拡張機能(たとえばVimium)で キーボード操作を変えている人は、一時的に無効にするなど適宜対応しましょう。
Vimiumでデフォルトの設定なら、i
を入力することで一時的にVimiumが無効になります。
その後、ESC
を入力することで再度Vimiumが有効になります。
リンク集
参考にした公式のドキュメントは以下です。
サンプルコードのGitHubのリンクは以下です。